Skip to content

Get a single Data Export

Request

Returns information on a single export that has been requested, including the status and the data sets and columns that were selected for the export.

This endpoint returns structured Data Export objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the exports top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - The user who generated the export.
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/exports/{id}?include=string'

Responses

The Data Export has been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
exportsobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "exports": {
    "property1": {
      "account_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "export_definition": {
        "property1": {
          "display_name": "string",
          "key": "string",
          "columns": [ … ],
          "filters": { … }
        },
        "property2": {
          "display_name": "string",
          "key": "string",
          "columns": [ … ],
          "filters": { … }
        }
      },
      "status": "string",
      "user_id": "string"
    },
    "property2": {
      "account_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "export_definition": {
        "property1": {
          "display_name": "string",
          "key": "string",
          "columns": [ … ],
          "filters": { … }
        },
        "property2": {
          "display_name": "string",
          "key": "string",
          "columns": [ … ],
          "filters": { … }
        }
      },
      "status": "string",
      "user_id": "string"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  }
}